home *** CD-ROM | disk | FTP | other *** search
/ The Atari Compendium / The Atari Compendium (Toad Computers) (1994).iso / files / umich / utils / nroff~yu.zoo / man.1 < prev    next >
Text File  |  1992-08-09  |  7KB  |  185 lines
  1.  
  2. NAME
  3.     man - read online documentation
  4.  
  5. SYNOPSIS
  6.     man   [-  [-ul]]  [-s  sect[subs]]  [-M  path]  [-m  path]  [-e]
  7.     [sect[subs]] name...
  8.     man -f file...
  9.     man -k keyword...
  10.  
  11. DESCRIPTION
  12.     The man command finds and displays  information  in  the  online
  13.     documentation set.   When the standard output is a terminal, man
  14.     pipes its output through less(1) or  the  name  of  the  command
  15.     specified with the MANPAGER or PAGER environment variables.
  16.  
  17. OPTIONS
  18.     The following command line options are recognized:
  19.  
  20.     -    Pipes  the  output through cat(1) rather than less(1) or
  21.         PAGER.
  22.  
  23.     -ul    Use ul(1) rather than cat(1).
  24.  
  25.     -M path
  26.         Specifies a directory tree  in  which  to  search.    By
  27.         default,  man  searches  in  d:\usr\man or the directory
  28.         specified by the MANPATH environment variable, the stan-
  29.         dard location for online  documentation.    This  option
  30.         assumes  path  is  the  root  of  a  !normal"  directory
  31.         structure.
  32.  
  33.     -m path
  34.         Specifies a directory in which to search.   This  option
  35.         does not  use a directory tree.  Files are searched only
  36.         in the directory specified by  path.    This  option  is
  37.         useful for  debugging  new  manpages.   For example, as-
  38.         suming you are working on a manpage named !mycmd.1", you
  39.         can do this:
  40.  
  41.             man -m . 1 mycmd
  42.  
  43.     -e    Find every manpage concerning the given name  regardless
  44.         of section.    It  is expected that a !normal" exit from
  45.         the pager will result in an exit status of 0  (in  which
  46.         case the  search  is  continued  in other sections).  An
  47.         !abnormal" exit should result in a nonzero  exit  status
  48.         and the search is then terminated.
  49.  
  50.     -s sect[subsect]
  51.         Specifies  a  section  and subsection similar to the 4.2
  52.         BSD UNIX Programmer's Manual  (as  explained  below)  in
  53.         which to  search.  If no section is specified, man sear-
  54.         ches through all of the sections.  Example: !man  -s  3s
  55.         fopen".
  56.  
  57.     sect    As  an  alternative  to  -s, you can specify the section
  58.         (and  optional  subsection)  as  the   first   argument.
  59.         Example: !man 3s fopen".
  60.  
  61.     name    Searches  for  documentation  files  associated with the
  62.         specified name.
  63.  
  64.     -f name
  65.         Displays a one line synopsis  of  each  online  documen-
  66.         tation   file  whose  names  match  the  specified  word
  67.         (equivalent to the whatis(1)  command).    For  example,
  68.         !man  -f  chmod" will give entries for both chmod(1) and
  69.         chmod(2).  Note that man invokes whatis(1) in this case,
  70.         so it should be found in the path (see ENVIRONMENT).
  71.  
  72.     -k keyword
  73.         Displays a one line synopsis  of  each  online  documen-
  74.         tation  file  whose  name  or  description  contains the
  75.         specified  keyword   (equivalent   to   the   apropos(1)
  76.         command).   Note  that  man  invokes  apropos(1) in this
  77.         case,  so  it  should  be  found  in   the   path   (see
  78.         ENVIRONMENT).
  79.  
  80. ENVIRONMENT
  81.     The following environment variables are recognized:
  82.  
  83.     MANPATH,MANDIR
  84.         Location  of main manual direcotry, where subdirectories
  85.         are to be found.  Man uses (in order  of  priority)  the
  86.         path  specified  with  -M, the MANPATH specified, or the
  87.         built-in default (c:\man).
  88.  
  89.     MANPAGER
  90.         Name of prefered pager.  Use  this  pager  if  you  have
  91.         compressed manpages  (see  manpager(1)).    Man will use
  92.         first MANPAGER, if found, then  PAGER,  if  found.    If
  93.         neither are found, it uses c:\bin\less.ttp.
  94.  
  95.     PAGER    Name of secondary pager to replace less(1).  Use this if
  96.         you  do  not  have  manpages generated with font changes
  97.         (see nroff(1)).  Either  MANPAGER  or  PAGER  should  be
  98.         defined.  The search order is MANPAGER then PAGER.
  99.  
  100. SECTION NAMES
  101.     The "sections" of the manual are:
  102.  
  103.     Sect    Section Name    Description
  104.     ----    -------------    --------------------------------------
  105.     0    General        overview of features and documentation
  106.     1    Commands    user commands
  107.     2    System Calls    low-level system library calls (C)
  108.     3    Library Calls    standard user calls (C)
  109.     4    Special Files    special system files and hardware
  110.     5    File formats    things like arc(1) file formats
  111.     6    Games        games manual
  112.     7    Miscellaneous    miscellaneous information
  113.     8    Administration    system administration commands
  114.  
  115.     In addition, man recognizes the following section names:
  116.  
  117.     local        files specific to local system
  118.     new        files added since current software release
  119.     old        files from previous software release
  120.     gnu        GNU files
  121.     paper        misc formal papers
  122.     doc        misc documentation
  123.  
  124.     The search order, if no section is specified, is:
  125.  
  126.     108234576
  127.  
  128.     In  addition  to  sections,  there  are  a number of subsections
  129.     possible,  though  these  files  do  not  reside  in  a  special
  130.     directory.   The  subsection name is simply appended to the file
  131.     name.  Example: !fopen.3s" resides in $MANPATH\man3, the section
  132.     is !3" (libraries) and the subsection is !s", stdio.    Here  is
  133.     the subsection search order for subsections in each section (the
  134.     square  brackets  mean  a  choice of each character contained in
  135.     them, in that order):
  136.  
  137.     man1\*.1[tcgesla]    util & text, com, graphics, edit, shell,
  138.                 lang, archival
  139.     man0\*.0
  140.     man8\*.8[s]        util & system
  141.     man2\*.2[gbx]        system & gemdos, bios, xbios
  142.     man3\*.3[msvcxg]    C lib & math, stdio, sysV, compat,
  143.                 extra, gem(aes/vdi)
  144.     man4\*.4[dkvscm]    general & disk, keyboard, video, sound,
  145.                 chips, memory
  146.     man5\*.5
  147.     man7\*.7
  148.     man6\*.6
  149.  
  150. NOTES
  151.     To save disk space, you can "source" other  files  by  including
  152.     the nroff(1)  directive  !.so"  in a file as the first line.  In
  153.     this case, the first line should start with .so followed  by  at
  154.     least  one  space,  then  the  file to use instead of the actual
  155.     manpage.    For   example,   the   manpage   for   feof.3s   (in
  156.     $MANPATH\man3) contains the single line:
  157.  
  158.         .so man3\ferror.3s
  159.  
  160.     which  will  cause  man  to  display the contents of !ferror.3s"
  161.     instead.  Note  the  relative  path  (relative  to  MANPATH,  by
  162.     default d:\usr\man).    In this way, numerous manpages can refer
  163.     to a single (larger) file.  Do not compress  files  with  source
  164.     lines  as man only checks for this line if it finds a file which
  165.     is not compressed.  Note that you can only  compress  files  for
  166.     viewing  with  manpager(1) and must set the MANPAGER environment
  167.     variable as well.
  168.  
  169. FILES
  170.     d:\usr\man        root of standard manual page directory tree
  171.     d:\usr\man\man*\*    manual entries
  172.     d:\usr\man\whatis    table of contents and keyword database
  173.  
  174. SEE ALSO
  175.     apropos(1), cat(1), less(1), manpager(1),  nroff(1),  whatis(1),
  176.     whatisin(1), whereis(1), man(7)
  177.  
  178. AUTHOR
  179.     Bill Rosenkranz
  180.     rosenkra@convex.com
  181.  
  182. VERSION
  183.     man v3.0 92/7/27 rosenkra
  184.  
  185.